/*******************************************************************************
 * Copyright 2011 Mauro Luigi Drago (drago.luigi@gmail.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
package com.bytenose.extrautils.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * A marker to mark <b>non-nullable</b> variables/fields/parameters/methods.
 * A variable/field/parameter is non-nullable if it cannot assume nullable values.
 * A method is non-nullable if it cannot return nullable values.
 * This annotation has a {@code RUNTIME} retention policy.
 * This annotation may be used only on variables/fields/parameters and on methods.
 * @author Mauro Luigi Drago
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.LOCAL_VARIABLE, 
	ElementType.PARAMETER, ElementType.METHOD})
public @interface NonNullable {

}
